docs: Update information regarding fileImporter SwiftUI API #3085
Conversation
|
Deploy preview ready for 3085! |
|
|
||
| For instrumentation, Sauce Labs must re-sign the app using our certificates and provisioning profiles, and change the bundle identifier to Sauce Labs wildcard identifier. | ||
|
|
||
| This is an inherent limitation of the Apple system. |
There was a problem hiding this comment.
The "this" here references the idea in the first paragraph, which makes me think this sentence should follow immediately after it.
| ### Unable to access Downloads folder using 'fileImporter' SwiftUI API | ||
| Apple prevents access to private sandbox data via fileImporter (and likely other APIs) after re-signing an app. | ||
|
|
||
| For instrumentation, Sauce Labs must re-sign the app using our certificates and provisioning profiles, and change the bundle identifier to Sauce Labs wildcard identifier. |
There was a problem hiding this comment.
This sentence could go first, as it's basically just a preamble to provide some context.
There was a problem hiding this comment.
Resolved
There was a problem hiding this comment.
We already say in the very beginning that we need to resign apps, I don't think we need to mention this here explicitly again
There was a problem hiding this comment.
@dmissmann thanks for the comment! I updated the docs
| @@ -149,3 +149,11 @@ We recommend that you try the following workaround: | |||
| 2. If the above solution does not work, try using a different network without the proxy. | |||
|
|
|||
| We do not have control over Apple's signature verification process. It is recommended to work with your network administrator to ensure that Apple's signature check is not blocked by the proxy. | |||
|
|
|||
| ### Unable to access Downloads folder using 'fileImporter' SwiftUI API | |||
| Apple prevents access to private sandbox data via fileImporter (and likely other APIs) after re-signing an app. | |||
There was a problem hiding this comment.
This page apparently uses a mix of "resigning" and "re-signing", but I think we should standardize on "resigning" everywhere.
There was a problem hiding this comment.
I agree. I've updated the docs
| For instrumentation, Sauce Labs must re-sign the app using our certificates and provisioning profiles, and change the bundle identifier to Sauce Labs wildcard identifier. | ||
|
|
||
| This is an inherent limitation of the Apple system. | ||
| The solution for the client is to not use instrumentation when accessing data using `fileImporter `. |
There was a problem hiding this comment.
These are public customer-facing docs, so I think we should refer to them in 2nd person rather than 3rd person (like we do in the rest of the page). This could just say "The only currently known workaround is X".
There was a problem hiding this comment.
Got it, thanks! I've updated the docs
There was a problem hiding this comment.
Lets also link to the apple documentation here https://developer.apple.com/documentation/swiftui/view/fileimporter(ispresented:allowedcontenttypes:allowsmultipleselection:oncompletion:)
There was a problem hiding this comment.
@dmissmann thanks for the comment! I updated the docs
| @@ -149,3 +149,11 @@ We recommend that you try the following workaround: | |||
| 2. If the above solution does not work, try using a different network without the proxy. | |||
|
|
|||
| We do not have control over Apple's signature verification process. It is recommended to work with your network administrator to ensure that Apple's signature check is not blocked by the proxy. | |||
|
|
|||
| ### Unable to access Downloads folder using 'fileImporter' SwiftUI API | |||
| Apple prevents access to private sandbox data via fileImporter (and likely other APIs) after re-signing an app. | |||
There was a problem hiding this comment.
Maybe also add a sentence about how the issue manifests itself (e.g. the app crashes).
There was a problem hiding this comment.
I added examples
|
Deploy preview ready for 3085! |
|
Deploy preview ready for 3085! |
1 similar comment
|
Deploy preview ready for 3085! |
|
Deploy preview ready for 3085! |
| @@ -149,3 +149,11 @@ We recommend that you try the following workaround: | |||
| 2. If the above solution does not work, try using a different network without the proxy. | |||
|
|
|||
| We do not have control over Apple's signature verification process. It is recommended to work with your network administrator to ensure that Apple's signature check is not blocked by the proxy. | |||
|
|
|||
| ### Unable to access Downloads folder using 'fileImporter' SwiftUI API | |||
There was a problem hiding this comment.
I would put this into it's own section
## Known Errors caused by resigning
In some cases resigning apps with a Sauce Labs certificate and provisioning profile breaks certain features of your app.
The known limitations are listed below and the only known workaround for those errors is to disable resigning using private devices.
### Unable to access Downloads folder using 'fileImporter' SwiftUI API
...
There was a problem hiding this comment.
@dmissmann thanks for the comment! I updated the docs
| ### Unable to access Downloads folder using 'fileImporter' SwiftUI API | ||
| Apple prevents access to private sandbox data via fileImporter (and likely other APIs) after re-signing an app. | ||
|
|
||
| For instrumentation, Sauce Labs must re-sign the app using our certificates and provisioning profiles, and change the bundle identifier to Sauce Labs wildcard identifier. |
There was a problem hiding this comment.
We already say in the very beginning that we need to resign apps, I don't think we need to mention this here explicitly again
| For instrumentation, Sauce Labs must re-sign the app using our certificates and provisioning profiles, and change the bundle identifier to Sauce Labs wildcard identifier. | ||
|
|
||
| This is an inherent limitation of the Apple system. | ||
| The solution for the client is to not use instrumentation when accessing data using `fileImporter `. |
There was a problem hiding this comment.
Lets also link to the apple documentation here https://developer.apple.com/documentation/swiftui/view/fileimporter(ispresented:allowedcontenttypes:allowsmultipleselection:oncompletion:)
|
Deploy preview ready for 3085! |
|
Deploy preview ready for 3085! |
Description
Update description regarding
fileImporterAPI.Motivation and Context
The customer enabled instrumentation and faced issues with accessing the Downloads folder using
fileImporterSwiftUI API.We should document that this is not supported due to a limitation in the Apple security system.
Types of Changes